api/v1/jobs/{jobno}/timers

Path: api/v1/jobs/{jobno}/timers

This API is JSON:API compliant.

This endpoint supports the following methods:
GET POST PATCH

This endpoint requires an OAuth bearer token, and returns errors in a standard shape. See API Conventions for authentication, error responses and paging, which apply to every endpoint.

The resource type for this endpoint is JobTimer
The identifier is jobno-refno

Attributes

The JobTimer resource type attributes are as follows:

Read-only — a tick means the value is set by Jim2 and cannot be changed through the API: it is returned in responses, but any value you send for it in a POST or PATCH is rejected.
Attribute names are case-sensitive and must be sent and read exactly as shown. The API mixes capitalisation styles — some names are PascalCase (e.g. Status, CustRef, DateDue) and others camelCase (e.g. dateIn, priceLevel) — so copy each name verbatim rather than assuming one convention. Filter names (in the filter list on the GET example) may differ from the attribute names.
Monetary and quantity values are decimal numbers whose number of decimal places depends on your Jim2 configuration. They are returned as JSON numbers with their scale preserved. Parse them as decimal / fixed-point values, not floating-point, to preserve precision.

Attribute	Type	Read-only	Description
Comment	string		The timer comment.
LabourInit	string		The initials of the staff member the timer is for. Defaults to the current user if not supplied.
LabourType	string		The labour type for the timer. Defaults to the user's labour type if not supplied.
LineNum	integer	✓	The line number of the timer on the job.
State	string		Must be left out or null when creating a timer. Otherwise may be Paused, Resumed, or Stopped. Note once stopped the timer will cease to exist (it become a simple labour entry on the job).

Example GET (Return specific)

Path: api/v1/jobs/10/timers/10-1

Response:

This example shows the maximum set of fields the endpoint can return, all populated. A real response only contains the data that applies to that record, so fields that are empty or not relevant are omitted — do not assume every field shown here will be present in every response.

{
  "data": {
    "id": "10-1",
    "type": "JobTimer",
    "attributes": {
      "LabourInit": "SYS",
      "Comment": "Onsite diagnostics",
      "LabourType": "Admin",
      "State": "Resumed",
      "LineNum": 2
    },
    "links": {
      "self": "/api/v1/jobs/10/timers/10-1"
    }
  }
}

Example POST

Path: api/v1/jobs/10/timers

Request:

{
    "data": {
        "type": "JobTimer",
        "attributes": {
            "LabourInit": "SYS",
            "Comment": "Timer started for diagnostics.",
            "LabourType": "Admin"
        }
    }
}

Response:

{
    "data": {
        "id": "10-3",
        "type": "JobTimer",
        "attributes": {
            "LabourInit": "SYS",
            "Comment": "Test",
            "LabourType": "Admin",
            "State": "Resumed",
            "LineNum": 3
        },
      "links": {
        "self": "/api/v1/jobs/10/timers/10-3"
      }
    }
}

Example PATCH

Path: api/v1/jobs/10/timers/10-1

Request:

{
    "data": {
        "id": "1",
        "type": "JobTimer",
        "attributes": {
            "LabourInit": "SYS",
            "Comment": "Timer running for diagnostics.",
            "LabourType": "Admin",
            "State": "Resumed"
        }
    }
}

Response:

{
  "data": {
    "id": "10-1",
    "type": "JobTimer",
    "attributes": {
      "LabourInit": "SYS",
      "Comment": "Test",
      "LabourType": "Admin",
      "State": "Resumed",
      "LineNum": 1
    },
    "links": {
      "self": "/api/v1/jobs/10/timers/10-1"
    }
  }
}